dxp-ux
listCustomerBill (TMF-678)
[GET]
The customerBill API provides below features,
#listCustomerBill#: This operation list customer bill entities from "ARIA, LIBERATE, CERILLION, CSG".
listCustomerBill
URL
http://[localhost]:[port]/dxp-ux/v1/{businessId}/customerBillURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code Ex: PR, JM, PA | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction Minimum characters: 1 | N It is mandatory for business |
| lob | string | The Line of Business Identifier currently available are: FIXED, POSTPAID Note : POSTPAID is mandatory for PR Aria and FIXED for PR Csg customers, Optional for JM | Y |
| channelId | string | This is to identify the source (Project). Value : APP | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| accountId | string | This is billing account number which is unique for the customer | Y |
| startDate | string | This is startDate for bills retrieval time period. Expected format : yyyy-MM-dd, Eg: 2021-09-16 Note: For Aria backend system we should have pass startDate as Mandatory, Start Date of Bill Period. Not applicable for 12 months bill (from Evertec+csg), when pdfId=true startDate is not applicable for FIXED Line (CSG) | N |
| endDate | string | This is endDate for bills retrieval time period. Expected format : yyyy-MM-dd, Eg: 2021-09-16 Note: For Aria backend system we should have pass endDate as Mandatory, End Date of Bill Period. Not applicable for 12 months bill (from Evertec+csg), when pdfId=true endDate is not applicable for FIXED Line (CSG) | N |
| pdfId | boolean | Flag to indicate that request is to retrieve the 12 months bill(3 months from csg and 9 months from evertec) and PDF Id will be available in billDocument.id, if value is true. If value is false, retrieve 3 months bill from csg. | N |
Note :
To fetch CustomerBill from PR Csg customers need to pass lob as "FIXED"
To fetch CustomerBill from PR Customers in Aria need to lob as "POSTPAID"
To fetch CustomerBill from JM Customers for Liberate and Cerillion need to pass businessId as "JM"
RESPONSE BODY FOR listCustomerBill - CSG FIXED
12 months bill from CSG and Evertec:
Note: Evertec 9 months bill contains, PDF id and bill date. AccountId Mapped from the request. billDocument.mimeType and billingAccount.@referredType are hardcoded values.
[
{
"id": "77751A00044743P0",
"href": "https://esb.lla.com/customerBillManagement/customerBill/77751A00044743P0",
"billNo": "77751A00044743P0",
"runType": "onCycle",
"category": "normal",
"state": "due",
"lastUpdate": "2022-09-09T00:00:00.000Z",
"billDate": "2022-09-05T00:00:00.000Z",
"nextBillDate": "2022-10-04T00:00:00.000Z",
"billingPeriod": {
"endDateTime": "2022-10-04T00:00:00.000Z",
"startDateTime": "2022-09-05T00:00:00.000Z"
},
"amountDue": {
"value": 16.44,
"unit": "USD"
},
"accountBalance": [
{
"amount": {
"value": 16.44,
"unit": "USD"
},
"type": "BeginningBalance"
}
],
"paymentDueDate": "2022-09-25T00:00:00.000Z",
"remainingAmount": {
"value": 16.44,
"unit": "USD"
},
"taxIncludedAmount": {
"value": 16.44,
"unit": "USD"
},
"@baseType": "bill",
"@type": "customerBill",
"appliedPayment": [
{
"appliedAmount": {
"value": 16.44,
"unit": "USD"
},
"payment": {
"id": "8779190000000010",
"paymentDate": "2022-08-09T00:00:00.000Z",
"@referredType": "payment"
}
}
],
"billingAccount": {
"id": "8211990051069995",
"href": "https://esb.lla.com/accountManagement/billingAccount/8211990051069995",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "billingAccount"
},
"taxItem": [
{
"taxCategory": "IVU ESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.53,
"unit": "USD"
}
},
{
"taxCategory": "IVU MUNICIPAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.05,
"unit": "USD"
}
},
{
"taxCategory": "CARGO POR SERVICIO DE 911 RESIDENCIAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.50,
"unit": "USD"
}
},
{
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.06,
"unit": "USD"
}
},
{
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.30,
"unit": "USD"
}
}
],
"relatedParty": [
{
"href": "https://esb.lla.com/partyManagement/individual/500",
"role": "issuer",
"id": "500",
"name": "LCPR",
"@referredType": "organizationParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "billReceiver",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "payer",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
}
],
"financialAccount": {
"id": "15",
"href": "https://esb.lla.com/accountManagement/financialAccount/15",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "financialAccount"
},
"billDocument": [
{
"id": "207570529",
"mimeType": "application/pdf"
}
]
},
{
"id": "77782A00045229P0",
"href": "https://esb.lla.com/customerBillManagement/customerBill/77782A00045229P0",
"billNo": "77782A00045229P0",
"runType": "onCycle",
"category": "normal",
"state": "due",
"lastUpdate": "2022-09-09T00:00:00.000Z",
"billDate": "2022-08-05T00:00:00.000Z",
"nextBillDate": "2022-09-04T00:00:00.000Z",
"billingPeriod": {
"endDateTime": "2022-09-04T00:00:00.000Z",
"startDateTime": "2022-08-05T00:00:00.000Z"
},
"amountDue": {
"value": 16.44,
"unit": "USD"
},
"accountBalance": [
{
"amount": {
"value": 16.44,
"unit": "USD"
},
"type": "BeginningBalance"
}
],
"paymentDueDate": "2022-08-25T00:00:00.000Z",
"remainingAmount": {
"value": 16.44,
"unit": "USD"
},
"taxIncludedAmount": {
"value": 16.44,
"unit": "USD"
},
"@baseType": "bill",
"@type": "customerBill",
"appliedPayment": [
{
"appliedAmount": {
"value": 16.44,
"unit": "USD"
},
"payment": {
"id": "8779290000000010",
"paymentDate": "2022-07-09T00:00:00.000Z",
"@referredType": "payment"
}
}
],
"billingAccount": {
"id": "8211990051069995",
"href": "https://esb.lla.com/accountManagement/billingAccount/8211990051069995",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "billingAccount"
},
"taxItem": [
{
"taxCategory": "IVU ESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.53,
"unit": "USD"
}
},
{
"taxCategory": "IVU MUNICIPAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.05,
"unit": "USD"
}
},
{
"taxCategory": "CARGO POR SERVICIO DE 911 RESIDENCIAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.50,
"unit": "USD"
}
},
{
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.06,
"unit": "USD"
}
},
{
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.30,
"unit": "USD"
}
}
],
"relatedParty": [
{
"href": "https://esb.lla.com/partyManagement/individual/500",
"role": "issuer",
"id": "500",
"name": "LCPR",
"@referredType": "organizationParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "billReceiver",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "payer",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
}
],
"financialAccount": {
"id": "15",
"href": "https://esb.lla.com/accountManagement/financialAccount/15",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "financialAccount"
},
"billDocument": [
{
"id": "205495579",
"mimeType": "application/pdf"
}
]
},
{
"id": "77813A00044768P0",
"href": "https://esb.lla.com/customerBillManagement/customerBill/77813A00044768P0",
"billNo": "77813A00044768P0",
"runType": "onCycle",
"category": "normal",
"state": "due",
"lastUpdate": "2022-09-09T00:00:00.000Z",
"billDate": "2022-07-05T00:00:00.000Z",
"nextBillDate": "2022-08-04T00:00:00.000Z",
"billingPeriod": {
"endDateTime": "2022-08-04T00:00:00.000Z",
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"amountDue": {
"value": 16.44,
"unit": "USD"
},
"accountBalance": [
{
"amount": {
"value": 15.32,
"unit": "USD"
},
"type": "BeginningBalance"
}
],
"paymentDueDate": "2022-07-25T00:00:00.000Z",
"remainingAmount": {
"value": 16.44,
"unit": "USD"
},
"taxIncludedAmount": {
"value": 16.44,
"unit": "USD"
},
"@baseType": "bill",
"@type": "customerBill",
"appliedPayment": [
{
"appliedAmount": {
"value": 15.32,
"unit": "USD"
},
"payment": {
"id": "8779390000000010",
"paymentDate": "2022-06-09T00:00:00.000Z",
"@referredType": "payment"
}
}
],
"billingAccount": {
"id": "8211990051069995",
"href": "https://esb.lla.com/accountManagement/billingAccount/8211990051069995",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "billingAccount"
},
"taxItem": [
{
"taxCategory": "IVU ESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.53,
"unit": "USD"
}
},
{
"taxCategory": "IVU MUNICIPAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.05,
"unit": "USD"
}
},
{
"taxCategory": "CARGO POR SERVICIO DE 911 RESIDENCIAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.50,
"unit": "USD"
}
},
{
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.06,
"unit": "USD"
}
},
{
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.30,
"unit": "USD"
}
}
],
"relatedParty": [
{
"href": "https://esb.lla.com/partyManagement/individual/500",
"role": "issuer",
"id": "500",
"name": "LCPR",
"@referredType": "organizationParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "billReceiver",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "payer",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
}
],
"financialAccount": {
"id": "15",
"href": "https://esb.lla.com/accountManagement/financialAccount/15",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "financialAccount"
},
"billDocument": [
{
"id": "203173532",
"mimeType": "application/pdf"
}
]
},
{
"billDocument": [
{
"id": "200938297",
"mimeType": "application/pdf"
}
],
"billDate": "2022-06-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "198794524",
"mimeType": "application/pdf"
}
],
"billDate": "2022-05-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "196562582",
"mimeType": "application/pdf"
}
],
"billDate": "2022-04-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "194461865",
"mimeType": "application/pdf"
}
],
"billDate": "2022-03-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "192410076",
"mimeType": "application/pdf"
}
],
"billDate": "2022-02-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "189909502",
"mimeType": "application/pdf"
}
],
"billDate": "2022-01-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "187723933",
"mimeType": "application/pdf"
}
],
"billDate": "2021-12-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "185684934",
"mimeType": "application/pdf"
}
],
"billDate": "2021-11-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "183468746",
"mimeType": "application/pdf"
}
],
"billDate": "2021-10-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
},
{
"billDocument": [
{
"id": "181330966",
"mimeType": "application/pdf"
}
],
"billDate": "2021-09-05T00:00:00-04:00",
"billingAccount": {
"id": "8211990051069995",
"@referredType": "billingAccount"
}
}
]3 months Bill from CSG:
[
{
"id": "77751A00044743P0",
"href": "https://esb.lla.com/customerBillManagement/customerBill/77751A00044743P0",
"billNo": "77751A00044743P0",
"runType": "onCycle",
"category": "normal",
"state": "due",
"lastUpdate": "2022-09-09T00:00:00.000Z",
"billDate": "2022-09-05T00:00:00.000Z",
"nextBillDate": "2022-10-04T00:00:00.000Z",
"billingPeriod": {
"endDateTime": "2022-10-04T00:00:00.000Z",
"startDateTime": "2022-09-05T00:00:00.000Z"
},
"amountDue": {
"value": 16.44,
"unit": "USD"
},
"accountBalance": [
{
"amount": {
"value": 16.44,
"unit": "USD"
},
"type": "BeginningBalance"
}
],
"paymentDueDate": "2022-09-25T00:00:00.000Z",
"remainingAmount": {
"value": 16.44,
"unit": "USD"
},
"taxIncludedAmount": {
"value": 16.44,
"unit": "USD"
},
"@baseType": "bill",
"@type": "customerBill",
"appliedPayment": [
{
"appliedAmount": {
"value": 16.44,
"unit": "USD"
},
"payment": {
"id": "8779190000000010",
"paymentDate": "2022-08-09T00:00:00.000Z",
"@referredType": "payment"
}
}
],
"billingAccount": {
"id": "8211990051069995",
"href": "https://esb.lla.com/accountManagement/billingAccount/8211990051069995",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "billingAccount"
},
"taxItem": [
{
"taxCategory": "IVU ESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.53,
"unit": "USD"
}
},
{
"taxCategory": "IVU MUNICIPAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.05,
"unit": "USD"
}
},
{
"taxCategory": "CARGO POR SERVICIO DE 911 RESIDENCIAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.50,
"unit": "USD"
}
},
{
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.06,
"unit": "USD"
}
},
{
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.30,
"unit": "USD"
}
}
],
"relatedParty": [
{
"href": "https://esb.lla.com/partyManagement/individual/500",
"role": "issuer",
"id": "500",
"name": "LCPR",
"@referredType": "organizationParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "billReceiver",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "payer",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
}
],
"financialAccount": {
"id": "15",
"href": "https://esb.lla.com/accountManagement/financialAccount/15",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "financialAccount"
}
},
{
"id": "77782A00045229P0",
"href": "https://esb.lla.com/customerBillManagement/customerBill/77782A00045229P0",
"billNo": "77782A00045229P0",
"runType": "onCycle",
"category": "normal",
"state": "due",
"lastUpdate": "2022-09-09T00:00:00.000Z",
"billDate": "2022-08-05T00:00:00.000Z",
"nextBillDate": "2022-09-04T00:00:00.000Z",
"billingPeriod": {
"endDateTime": "2022-09-04T00:00:00.000Z",
"startDateTime": "2022-08-05T00:00:00.000Z"
},
"amountDue": {
"value": 16.44,
"unit": "USD"
},
"accountBalance": [
{
"amount": {
"value": 16.44,
"unit": "USD"
},
"type": "BeginningBalance"
}
],
"paymentDueDate": "2022-08-25T00:00:00.000Z",
"remainingAmount": {
"value": 16.44,
"unit": "USD"
},
"taxIncludedAmount": {
"value": 16.44,
"unit": "USD"
},
"@baseType": "bill",
"@type": "customerBill",
"appliedPayment": [
{
"appliedAmount": {
"value": 16.44,
"unit": "USD"
},
"payment": {
"id": "8779290000000010",
"paymentDate": "2022-07-09T00:00:00.000Z",
"@referredType": "payment"
}
}
],
"billingAccount": {
"id": "8211990051069995",
"href": "https://esb.lla.com/accountManagement/billingAccount/8211990051069995",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "billingAccount"
},
"taxItem": [
{
"taxCategory": "IVU ESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.53,
"unit": "USD"
}
},
{
"taxCategory": "IVU MUNICIPAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.05,
"unit": "USD"
}
},
{
"taxCategory": "CARGO POR SERVICIO DE 911 RESIDENCIAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.50,
"unit": "USD"
}
},
{
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.06,
"unit": "USD"
}
},
{
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.30,
"unit": "USD"
}
}
],
"relatedParty": [
{
"href": "https://esb.lla.com/partyManagement/individual/500",
"role": "issuer",
"id": "500",
"name": "LCPR",
"@referredType": "organizationParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "billReceiver",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "payer",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
}
],
"financialAccount": {
"id": "15",
"href": "https://esb.lla.com/accountManagement/financialAccount/15",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "financialAccount"
}
},
{
"id": "77813A00044768P0",
"href": "https://esb.lla.com/customerBillManagement/customerBill/77813A00044768P0",
"billNo": "77813A00044768P0",
"runType": "onCycle",
"category": "normal",
"state": "due",
"lastUpdate": "2022-09-09T00:00:00.000Z",
"billDate": "2022-07-05T00:00:00.000Z",
"nextBillDate": "2022-08-04T00:00:00.000Z",
"billingPeriod": {
"endDateTime": "2022-08-04T00:00:00.000Z",
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"amountDue": {
"value": 16.44,
"unit": "USD"
},
"accountBalance": [
{
"amount": {
"value": 15.32,
"unit": "USD"
},
"type": "BeginningBalance"
}
],
"paymentDueDate": "2022-07-25T00:00:00.000Z",
"remainingAmount": {
"value": 16.44,
"unit": "USD"
},
"taxIncludedAmount": {
"value": 16.44,
"unit": "USD"
},
"@baseType": "bill",
"@type": "customerBill",
"appliedPayment": [
{
"appliedAmount": {
"value": 15.32,
"unit": "USD"
},
"payment": {
"id": "8779390000000010",
"paymentDate": "2022-06-09T00:00:00.000Z",
"@referredType": "payment"
}
}
],
"billingAccount": {
"id": "8211990051069995",
"href": "https://esb.lla.com/accountManagement/billingAccount/8211990051069995",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "billingAccount"
},
"taxItem": [
{
"taxCategory": "IVU ESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.53,
"unit": "USD"
}
},
{
"taxCategory": "IVU MUNICIPAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.05,
"unit": "USD"
}
},
{
"taxCategory": "CARGO POR SERVICIO DE 911 RESIDENCIAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.50,
"unit": "USD"
}
},
{
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.06,
"unit": "USD"
}
},
{
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL",
"taxRate": 0.00,
"taxAmount": {
"value": 0.30,
"unit": "USD"
}
}
],
"relatedParty": [
{
"href": "https://esb.lla.com/partyManagement/individual/500",
"role": "issuer",
"id": "500",
"name": "LCPR",
"@referredType": "organizationParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "billReceiver",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
},
{
"href": "https://esb.lla.com/partyManagement/individual/710",
"role": "payer",
"id": "710",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "individualParty"
}
],
"financialAccount": {
"id": "15",
"href": "https://esb.lla.com/accountManagement/financialAccount/15",
"name": "NEDDY ACEVEDO DAVILA",
"@referredType": "financialAccount"
}
}
]RESPONSE BODY FOR listCustomerBill - Aria POSTPAID
[
{
"id": "1197482673",
"billNo": "2095132367",
"category": "Anniversary Period Invoice",
"state": "onHold",
"lastUpdate": "2021-11-29T00:00:00+00:00",
"billDate": "2023-04-18T00:00:00+00:00",
"nextBillDate": "2021-12-28T00:00:00+00:00",
"paymentDueDate": "2023-05-03T00:00:00+00:00",
"billingPeriod": {
"endDateTime": "2021-11-28T00:00:00+00:00",
"startDateTime": "2021-10-29T00:00:00+00:00"
},
"amountDue": {
"value": 146.66,
"unit": "usd"
},
"remainingAmount": {
"value": 156.66,
"unit": "usd"
},
"taxIncludedAmount": {
"unit": "usd",
"value": 186.66
},
"@baseType": "bill",
"@type": "CustomerBill",
"billingAccount": {
"id": "20221124-00060001",
"@type": "BillingAccount"
},
"appliedPayment": [
{
"appliedAmount": {
"value": 196.66,
"unit": "usd"
}
}
],
"relatedParty": [
{
"id": "33218056",
"@type": "AriaAccount"
},
{
"id": "20221124-00060001_BG_001",
"@type": "BillingGroup"
}
]
}
]Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | The Aria-assigned unique identifier of a given invoice. | N |
| billNo | string | The unique statement number that is sequenced across all statements (not limited to xml only). | N |
| category | string | This field identifies the type of the invoice generated | N |
| state | string | Status of the invoice, Possible values will be "onHold, new, settled" | N |
| lastUpdate | string | The recurring bill-from date. | N |
| billDate | string | The date the invoice was billed. | N |
| nextBillDate | string | The recurring bill-through date. | N |
| paymentDueDate | string | The date monies are due. | N |
| billingPeriod | object | A time period. | N |
| billingPeriod.endDateTime | datetime | The usage bill-through date of the invoice | N |
| billingPeriod.startDateTime | datetime | The usage bill from date. | N |
| amountDue | object | A money | N |
| amountDue.value | string | Total amount of the statement. | N |
| amountDue.unit | string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | N |
| remainingAmount | object | A money | N |
| remainingAmount.value | string | The monetary amount to apply as balance forward. | N |
| remainingAmount.unit | string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | N |
| taxIncludedAmount | object | A money | N |
| taxIncludedAmount.value | string | The monetary amount of new charges detailed in the statement. | N |
| taxIncludedAmount.unit | string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | N |
| @baseType | string | When sub-classing, this defines the super-class | N |
| @type | string | When sub-classing, this defines the sub-class Extensible name. | N |
| billingAccount | object | BillingAccount reference | N |
| billingAccount.id | string | This is the client-assigned identifier for the account. | N |
| billingAccount.@type | string | When sub-classing, this defines the sub-class Extensible name. | N |
| appliedPayment | array | A list of applied payments | N |
| appliedPayment.appliedAmount | object | A money | N |
| appliedPayment.appliedAmount.value | object | The monetary amount of any new payments applied in this statement | N |
| appliedPayment.appliedAmount.unit | object | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | N |
| relatedParty | object | A related party | N |
| relatedParty.id | object | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | N |
| relatedParty.@type | object | When sub-classing, this defines the sub-class Extensible |
name. | N |
RESPONSE BODY FOR listCustomerBill - JM LIBERATE
[
{
"id": "0",
"billNo": "2022021",
"billDate": "2022-03-03T23:59:59.000Z",
"paymentDueDate": "2022-03-23T00:00:00.000Z",
"amountDue": {
"unit": "JMD",
"value": 2649.66
},
"appliedPayment": [
{
"appliedAmount": {
"unit": "JMD",
"value": 0
}
},
{
"payment": {
"paymentDate": "9999-12-31T00:00:00.000Z",
"@referredType": "payment"
}
}
],
"billingAccount": {
"id": "860019440000",
"@referredType": "billingAccount"
},
"financialAccount": {
"id": "860019440000",
"@referredType": "financialAccount",
"accountBalance": [
{
"balanceType": "balanceBroughtForward",
"amount": {
"unit": "JMD",
"value": -336.13
}
},
{
"balanceType": "balanceCarriedForward",
"amount": {
"unit": "JMD",
"value": 2313.53
}
},
{
"balanceType": "billAdjustmentAmount",
"amount": {
"unit": "JMD",
"value": 0
}
}
]
},
"remainingAmount": {
"unit": "JMD",
"value": 2313.53
},
"taxIncludedAmount": {
"unit": "JMD",
"value": 2649.66
},
"taxExcludedAmount": {
"unit": "JMD",
"value": 0
},
"taxItem": [
{
"taxCategory": "queryTaxAmount",
"taxAmount": {
"unit": "JMD",
"value": 0
}
}
],
"characteristic": [
{
"name": "queryAmount",
"value": 0,
"valueType": "JMD"
},
{
"name": "adjustAmount",
"value": 0,
"valueType": "JMD"
}
],
"@baseType": "bill",
"@type": "customerBill"
}
]RESPONSE BODY FOR listCustomerBill - JM CERILLION
[
{
"id": "28372884",
"billNo": "28372884",
"billDate": "2022-02-13T00:00:00.000Z",
"amountDue": {
"value": 8039.2,
"unit": "JMD"
},
"appliedPayment": {
"appliedAmount": {
"value": 0,
"unit": "JMD"
},
"payment": {
"id": "28372884",
"paymentDate": "0001-01-01T00:00:00.000Z",
"@referredType": "payment"
}
},
"paymentDueDate": "2022-03-12T00:00:00.000Z",
"taxIncludedAmount": {
"value": 8039.2,
"unit": "JMD"
},
"remainingAmount": {
"value": 0,
"unit": "JMD"
},
"relatedParty": [
{
"id": "118962",
"name": "MARVA STUPART"
}
],
"billingAccount": {
"id": "50146303",
"@referredType": "billingAccount"
},
"characteristic": [
{
"name": "adjustAmount",
"value": -250,
"valueType": ""
},
{
"name": "adjustAmount",
"value": -51.16,
"valueType": ""
},
{
"name": "adjustAmount",
"value": -107.05,
"valueType": ""
},
{
"name": "adjustAmount",
"value": 0,
"valueType": ""
},
{
"name": "currentBalance",
"value": 8098.31,
"valueType": ""
}
],
"financialAccount": {
"accountBalance": [
{
"balanceType": "balanceBroughtForward",
"amount": {
"unit": "JMD",
"value": 7340.89
}
},
{
"balanceType": "balanceCarriedForward",
"amount": {
"unit": "JMD",
"value": 8039.2
}
},
{
"balanceType": "billOutstandingBalance",
"amount": {
"unit": "JMD",
"value": 8039.2
}
},
{
"balanceType": "totalBillableAmount",
"amount": {
"unit": "JMD",
"value": 8039.2
}
}
]
},
"@baseType": "bill",
"@type": "customerBill"
},
{
"id": "28151082",
"billNo": "28151082",
"billDate": "2022-01-13T00:00:00.000Z",
"amountDue": {
"value": 7340.89,
"unit": "JMD"
},
"appliedPayment": {
"appliedAmount": {
"value": 7340.89,
"unit": "JMD"
},
"payment": {
"id": "28151082",
"paymentDate": "2022-02-03T00:00:00.000Z",
"@referredType": "payment"
}
},
"paymentDueDate": "2022-02-09T00:00:00.000Z",
"taxIncludedAmount": {
"value": 7340.89,
"unit": "JMD"
},
"remainingAmount": {
"value": 0,
"unit": "JMD"
},
"relatedParty": [
{
"id": "118962",
"name": "MARVA STUPART"
}
],
"billingAccount": {
"id": "50146303",
"@referredType": "billingAccount"
},
"characteristic": [
{
"name": "adjustAmount",
"value": -250,
"valueType": ""
},
{
"name": "adjustAmount",
"value": -3.71,
"valueType": ""
},
{
"name": "adjustAmount",
"value": -10.11,
"valueType": ""
},
{
"name": "adjustAmount",
"value": 0,
"valueType": ""
},
{
"name": "currentBalance",
"value": 8079.38,
"valueType": ""
}
],
"financialAccount": {
"accountBalance": [
{
"balanceType": "balanceBroughtForward",
"amount": {
"unit": "JMD",
"value": 8261.51
}
},
{
"balanceType": "balanceCarriedForward",
"amount": {
"unit": "JMD",
"value": 0
}
},
{
"balanceType": "billOutstandingBalance",
"amount": {
"unit": "JMD",
"value": 0
}
},
{
"balanceType": "totalBillableAmount",
"amount": {
"unit": "JMD",
"value": 8039.2
}
}
]
},
"@baseType": "bill",
"@type": "customerBill"
}
]Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | Unique identifier of the bill | Y |
| href | string | Bill unique reference | N |
| billDate | datetime | Bill date | N |
| billNo | string | Bill reference known by the customer or the party and displayed on the bill. Could be different from the id | N |
| category | string | Category of the bill produced : normal, duplicate, interim, last, trial customer or credit note for example | N |
| lastUpdate | datetime | Date of bill last update | N |
| nextBillDate | datetime | Approximate date of the next bill production given for information (only used for onCycle bill) | N |
| paymentDueDate | datetime | Date at which the amount due should have been paid. In case DueDateMessage from csg is "ON RECPT"/ "UPON RECPT" indicates immediate payment, current date is mapped to DueDate | N |
| runType | string | onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close) | N |
| amountDue | object | N | |
| amountDue.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| amountDue.value | number | A positive floating point number | N |
| accountBalance | array | Balances linked to the account | N |
| accountBalance.amount | object | Balance amount | N |
| accountBalance.balanceType | string | Type of the balance - Previous Balance, deposit balance, disputed balance, loyalty balance, receivable balance...Default value is "BeginningBalance" | N |
| accountBalance.amount.value | number | A floating point number | N |
| accountBalance.amount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| accountBalance.validFor | object | The period of time for which the attachment is valid. Not in scope | N |
| accountBalance.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | N |
| accountBalance.validFor.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end | N |
| appliedPayment | array | The applied payment is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill. | N |
| appliedPayment.appliedAmount | object | N | |
| appliedPayment.appliedAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| appliedPayment.appliedAmount.value | number | A positive floating point number | N |
| appliedPayment.payment | object | A EntityRef is a detailed description of a bill structure. | N |
| appliedPayment.payment.id | string | Unique identifier for the EntityRef | N |
| appliedPayment.payment.href | string | Reference of the EntityRef | N |
| appliedPayment.payment.name | string | Name of the EntityRe | N |
| appliedPayment.payment.@baseType | string | When sub-classing, this defines the super-class | N |
| appliedPayment.payment.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| appliedPayment.payment.@type | string | When sub-classing, this defines the sub-class entity name | N |
| appliedPayment.payment.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| appliedPayment.@baseType | string | When sub-classing, this defines the super-class | N |
| appliedPayment.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| appliedPayment.@type | string | When sub-classing, this defines the sub-class entity name | N |
| billDocument | array | An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself. Not in scope for list customerBill | N |
| billDocument.id | string | Unique identifier for this particular attachment | N |
| billDocument.href | string | URI for this Attachment | N |
| billDocument.attachmentType | string | Attachment type such as video, picture | N |
| billDocument.content | string | The actual contents of the attachment object, if embedded, encoded as base64 | N |
| billDocument.description | string | A narrative text describing the content of the attachment | N |
| billDocument.mimeType | string | Attachment mime type such as extension file for video, picture and document | N |
| billDocument.name | string | The name of the attachment | N |
| billDocument.@type | string | When sub-classing, this defines the sub-class entity name | N |
| billDocument.content | string | The actual contents of the attachment object, if embedded, encoded as base64 | N |
| billDocument.url | string | Uniform Resource Locator, is a web page address (a subset of URI) | N |
| billDocument.size | Object | N | |
| billDocument.size.amount | number | The size of the attachment. | N |
| billDocument.size.units | string | Unit of the attachment. Eg: "bytes" | N |
| billDocument.validFor | object | The period of time for which the attachment is valid | N |
| billDocument.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | N |
| billDocument.validFor.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end | N |
| billingAccount | object | A EntityRef is a detailed description of a bill structure. | N |
| billingAccount.id | string | Unique identifier for the EntityRef | N |
| billingAccount.href | string | Reference of the EntityRef | N |
| billingAccount.name | string | Name of the EntityRe | N |
| billingAccount.@baseType | string | When sub-classing, this defines the super-class | N |
| billingAccount.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| billingAccount.@type | string | When sub-classing, this defines the sub-class entity name | N |
| billingAccount.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| billingPeriod | object | N | |
| billingPeriod.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | N |
| billingPeriod.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end | N |
| financialAccount | object | AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. | N |
| financialAccount.id | string | Unique identifier for the account | N |
| financialAccount.href | string | Reference of the account | N |
| financialAccount.name | string | Name of the account | N |
| financialAccount.accountBalance | object | Balances linked to the account | N |
| financialAccount.@baseType | string | When sub-classing, this defines the super-class | N |
| financialAccount.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| financialAccount.@type | string | When sub-classing, this defines the sub-class entity name | N |
| financialAccount.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| financialAccount.accountBalance.balanceType | string | Type of the balance ; deposit balance, disputed balance, loyalty balance, receivable balance | N |
| financialAccount.accountBalance.amount | object | N | |
| financialAccount.accountBalance.amount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| financialAccount.accountBalance.amount.value | number | A positive floating point number | N |
| financialAccount.accountBalance.validFor | Object | A period of time | N |
| financialAccount.accountBalance.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | N |
| financialAccount.accountBalance.validFor.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end | N |
| financialAccount.accountBalance.@baseType | string | When sub-classing, this defines the super-class | N |
| financialAccount.accountBalance.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| financialAccount.accountBalance.@type | string | When sub-classing, this defines the sub-class entity name | N |
| paymentMethod | object | Not in scope for this resource. | N |
| paymentMethod.id | string | Unique identifier for the EntityRef | N |
| paymentMethod.href | string | Reference of the EntityRef | N |
| paymentMethod.name | string | Name of the EntityRe | N |
| paymentMethod.@baseType | string | When sub-classing, this defines the super-class | N |
| paymentMethod.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| paymentMethod.@type | string | When sub-classing, this defines the sub-class entity name | N |
| paymentMethod.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| relatedParty | array | Related Entity reference. A related party defines party or party role linked to a specific entity | N |
| relatedParty.id | string | Unique identifier for the related entity. | N |
| relatedParty.href | string | Reference of the related entity. | N |
| relatedParty.name | string | Name of the related entity. | N |
| relatedParty.role | string | Role played by the related party | N |
| relatedParty.@baseType | string | When sub-classing, this defines the super-class | N |
| relatedParty.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| relatedParty.@type | string | When sub-classing, this defines the sub-class entity name | N |
| relatedParty.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| remainingAmount | Object | N | |
| remainingAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| remainingAmount.value | number | A positive floating point number | N |
| state | string | enum: - new - onHold - validated - sent - partiallyPaid - settled - due - paid | Y |
| taxExcludedAmount | object | Not in scope. | N |
| taxExcludedAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| taxExcludedAmount.value | number | A positive floating point number | N |
| taxIncludedAmount | object | N | |
| taxIncludedAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| taxIncludedAmount.value | number | A positive floating point number | N |
| taxItem | array | N | |
| taxItem.taxCategory | string | tax Category | N |
| taxItem.taxRate | number | Applied rate of the tax | N |
| taxItem.taxAmount | Object | Amount of tax expressed in the given currency | N |
| taxItem.taxAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| taxItem.taxAmount.value | number | A positive floating point number | N |
| @baseType | string | When sub-classing, this defines the super-class | N |
| @schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| @type | string | When sub-classing, this defines the sub-class entity name | N |
Possible Error Scenarios: :
IF WE ARE PASSING INVALID (accountId) NUMBER IN QUERYPARAMS
{
"errors": [
{
"code": 400,
"message": "ARIA:INVOICE_HISTORY",
"description": "1009 | account does not exist"
}
]
}
{
"errors": [
{
"code": 404,
"message": "** CIP09W - UNABLE TO XREF SUB PREFIX For ACCOUNTNO : 8211990010042298",
"description": "2099 ** CIP09W - UNABLE TO XREF SUB PREFIX"
}
]
}
{
"errors": [
{
"code": 404,
"message": "Liberate : Customer bill history not found for account no: 860019440001",
"description": "NOACCTSFOUND-No Accounts Found."
}
]
}IF WE ARE PASSING BLANK (startDate) IN QUERYPARAMS
{
"errors": [
{
"code": 400,
"message": "VALIDATION:BLANK_STRING",
"description": "Start Date cannot be blank"
}
]
}IF WE ARE PASSING BLANK (endDate) IN QUERYPARAMS
{
"errors": [
{
"code": 400,
"message": "VALIDATION:BLANK_STRING",
"description": "End Date cannot be blank"
}
]
}INVALID URL
{
"errors": [
{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method get not allowed for : /{businessId}"
}
]
}INVALID LOB
{
"errors": [
{
"code": 400,
"message": "ERROR:LOB_VALIDATION",
"description": "Lob must be of type POSTPAID"
}
]
}